// Copyright (c) Appeon. All rights reserved.
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. 
// You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

namespace SnapObjects.Data
{
    public interface ISqlColumn
    {
        /// <summary>
        ///     Gets the alias of the table where the column belongs to.
        /// </summary>
        string TableAlias { get; }

        /// <summary>
        ///     Gets the name of the column which the property is mapped to.
        /// </summary>
        string Column { get; }

        /// <summary>
        ///     Gets the alias of the column which the property is mapped to.
        /// </summary>
        string ColumnAlias { get; }

        /// <summary>
        ///     Gets whether the table (where the column belongs to) has an alias.
        /// </summary>
        bool TableAliasDefined { get; }

        /// <summary>
        ///     Gets whether the column has an alias.
        /// </summary>
        bool ColumnAliasDefined { get; }

        /// <summary>
        ///     Gets or sets the zero-based order of the column which the property is mapped to.
        /// </summary>
        int Order { get; }

        /// <summary>
        ///     Gets or sets the data type (specific to the database provider) of the
        ///     column which the property is mapped to.
        /// </summary>
        string TypeName { get; }

        bool TypeNameDefined { get; }
    }
}
